home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat1 / explain.z / explain
Encoding:
Text File  |  2001-04-17  |  11.8 KB  |  199 lines

  1.  
  2.  
  3.  
  4. eeeexxxxppppllllaaaaiiiinnnn((((1111))))                                                          eeeexxxxppppllllaaaaiiiinnnn((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      explain - displays the explanation for an error message
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn _m_s_g_i_d
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      The _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn utility retrieves and outputs a message explanation from an
  16.      online explanation catalog.  If the output device is a terminal, the
  17.      output of _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn is piped through the pager specified in the _PPPP_AAAA_GGGG_EEEE_RRRR
  18.      variable.  If _PPPP_AAAA_GGGG_EEEE_RRRR is not specified, the default pager _mmmm_oooo_rrrr_eeee _----_ssss is used.
  19.      If the output device is not a terminal, the output of _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn is sent to
  20.      the standard output device (_ssss_tttt_dddd_oooo_uuuu_tttt).
  21.  
  22.      The _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn command requires the following argument:
  23.  
  24.      _m_s_g_i_d  Specifies the message ID string associated with a message that
  25.             appears when an error message is output.  This string consists of
  26.             the product group code and the message number.  The product group
  27.             code (_g_r_o_u_p) is a string that identifies the product issuing the
  28.             message.  The message number (_m_s_g#) specifies which message within
  29.             the product you have received.  Enter the message ID as an
  30.             argument to _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn in the form _g_r_o_u_p_m_s_g# or in the form _g_r_o_u_p-
  31.             _m_s_g#.  If the group code ends in one or more digits (for example,
  32.             _cccc_ffff_9999_0000), you must use the form that includes the dash (_----).
  33.  
  34.    RRRReeeeccccooooggggnnnniiiizzzzeeeedddd GGGGrrrroooouuuupppp CCCCooooddddeeeessss
  35.      The following tables show the products and group codes that have message
  36.      and explanation catalogs on IRIX systems.  The first column lists the
  37.      group code (needed to look up the explanations for messages); the second
  38.      column gives the complete name of the software product or products
  39.      associated with the group code.
  40.  
  41.      Group Code   Software Product
  42.      _aaaa_cccc_cccc_tttt         Comprehensive System Accounting (CSA)
  43.      _cccc_ffff_9999_0000         _ffff_9999_0000 version 7.2
  44.      _dddd_mmmm           Data Migration Facility
  45.      _llll_iiii_bbbb          Fortran 90 library version 2.0, and _llll_iiii_bbbb_ffff_ffff_iiii_oooo
  46.      _mmmm_ssss_gggg_ssss_yyyy_ssss       _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn(1) and _cccc_aaaa_tttt_eeee_rrrr_rrrr(1) utilities
  47.      _nnnn_qqqq_ssss          Network Queuing System
  48.  
  49.    LLLLooooccccaaaattttiiiioooonnnn ooooffff EEEExxxxppppllllaaaannnnaaaattttiiiioooonnnn CCCCaaaattttaaaallllooooggggssss
  50.      To find the explanation for the message, _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn searches the path
  51.      specified in the _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH environment variable for the _g_r_o_u_p_...._eeee_xxxx_pppp file.
  52.      The value of the _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH variable depends on the _LLLL_AAAA_NNNN_GGGG environment
  53.      variable or the _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS category.  If _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn cannot access an
  54.      existing explanation catalog, check the value of the _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH environment
  55.      variable and either the _LLLL_AAAA_NNNN_GGGG environment variable or the _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS
  56.      category to ensure that the pathname of the catalog is in the message
  57.      system search path.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. eeeexxxxppppllllaaaaiiiinnnn((((1111))))                                                          eeeexxxxppppllllaaaaiiiinnnn((((1111))))
  71.  
  72.  
  73.  
  74.      See _eeee_nnnn_vvvv_iiii_rrrr_oooo_nnnn(5) for a description of the _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH, _LLLL_AAAA_NNNN_GGGG, and _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS
  75.      components.
  76.  
  77.    MMMMeeeessssssssaaaaggggeeee FFFFoooorrrrmmmmaaaatttt VVVVaaaarrrriiiiaaaabbbblllleeeessss
  78.      If _m_s_g_i_d does not appear with the error message or if you want to change
  79.      the format of the messages you receive, you can modify your _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT
  80.      and _CCCC_MMMM_DDDD_MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT environment variables.  Both variables can be set to
  81.      define the fields and the order of the fields to be included in message
  82.      output.
  83.  
  84.      The _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT variable controls the format in which you receive error
  85.      messages from programs that use the message formatting function
  86.      _cccc_aaaa_tttt_mmmm_ssss_gggg_ffff_mmmm_tttt(3C).  These are most messages in group codes other than _mmmm_ssss_gggg_ssss_yyyy_ssss.
  87.  
  88.      The _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn and _cccc_aaaa_tttt_eeee_rrrr_rrrr utilities use either _CCCC_MMMM_DDDD_MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT or _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT
  89.      variables; however, _CCCC_MMMM_DDDD_MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT is used before _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT.
  90.  
  91.    MMMMeeeessssssssaaaaggggeeee FFFFoooorrrrmmmmaaaatttt SSSSyyyynnnnttttaaaaxxxx
  92.      Valid fields for _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT and _CCCC_MMMM_DDDD_MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT are as follows:
  93.  
  94.      _%%%%_GGGG   Group code
  95.  
  96.      _%%%%_NNNN   Message number
  97.  
  98.      _%%%%_CCCC   Command name
  99.  
  100.      _%%%%_SSSS   Severity level
  101.  
  102.      _%%%%_PPPP   Position of the error
  103.  
  104.      _%%%%_MMMM   Message text
  105.  
  106.      _%%%%_DDDD   Debugging information
  107.  
  108.      _%%%%_TTTT   Time stamp
  109.  
  110.      If one of the _%%%% fields is not present in the contents of _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT or
  111.      _CCCC_MMMM_DDDD_MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT, the corresponding message field is not printed.
  112.  
  113.      The default message format is produced by the following assumed
  114.      _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT contents:
  115.  
  116.           %G-%N  %C: %S %P\n  %M\n
  117.  
  118.  
  119.      For messages issued by the IRIX utilities _eeee_xxxx_pppp_llll_aaaa_iiii_nnnn(1) and _cccc_aaaa_tttt_eeee_rrrr_rrrr(1), the
  120.      default message format is produced by the following assumed _CCCC_MMMM_DDDD_MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT
  121.      contents:
  122.  
  123.           %G-%N: %C %M\n
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. eeeexxxxppppllllaaaaiiiinnnn((((1111))))                                                          eeeexxxxppppllllaaaaiiiinnnn((((1111))))
  137.  
  138.  
  139.  
  140.      Messages issued from the _cccc_mmmm_dddd group code determine their format according
  141.      to the following precedence:
  142.  
  143.      1    Content of _CCCC_MMMM_DDDD_MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT variable, if it exists
  144.  
  145.      1    Content of _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT variable, if it exists
  146.  
  147.      1    Default message format for utilities
  148.  
  149.      The format of the time stamp (_%%%%_TTTT) is equivalent to that produced by the
  150.      _cccc_ffff_tttt_iiii_mmmm_eeee(3C) function and can be overridden by the _CCCC_FFFF_TTTT_IIII_MMMM_EEEE environment
  151.      variable.  For details about time stamp formats, see the _ssss_tttt_rrrr_ffff_tttt_iiii_mmmm_eeee(3C) man
  152.      page, which documents the _cccc_ffff_tttt_iiii_mmmm_eeee function.
  153.  
  154.      The Standard C _pppp_rrrr_iiii_nnnn_tttt_ffff escape sequences also can be embedded in the
  155.      contents of _MMMM_SSSS_GGGG______FFFF_OOOO_RRRR_MMMM_AAAA_TTTT.  The following table lists special characters
  156.      that can be embedded.
  157.  
  158.      Description       Symbol    Sequence
  159.      New-line char     NL (LF)   _\\\\_nnnn
  160.      Horizontal tab    HT        _\\\\_tttt
  161.      Vertical tab      VT        _\\\\_vvvv
  162.      Backspace         BS        _\\\\_bbbb
  163.      Carriage return   CR        _\\\\_rrrr
  164.      Form feed         FF        _\\\\_ffff
  165.      Audible alert     BEL       _\\\\_aaaa
  166.      Backslash         \         _\\\\_\\\\
  167.      Question mark     ?         _\\\\_????
  168.      Single quot.      '         _\\\\_''''
  169.      Double quot.      "         _\\\\_""""
  170.      Octal number      ooo       _\\\\_o_o_o
  171.      Hex. number       hh        _\\\\_xxxx_h_h
  172.  
  173.      The escape \_o_o_o consists of the backslash followed by 1, 2, or 3 octal
  174.      digits, which are taken to specify the value of the desired character.  A
  175.      common example of this construction is _\\\\_0000 which specifies the null
  176.      character.  The escape _\\\\_xxxx_h_h consists of the backslash, followed by _xxxx,
  177.      followed by hexadecimal digits, which are taken to specify the value of
  178.      the desired character.  There is no limit on the number of digits, but
  179.      the behavior is undefined if the resulting character value exceeds that
  180.      of the largest character.
  181.  
  182.      Any characters other than those listed in this table are passed through
  183.      without the backslash, (for example, _\\\\_qqqq produces _qqqq).
  184.  
  185. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  186.      caterr(1), gencat(1), catgetmsg(3C), catmsgfmt(3C), msg(7D).
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.